Skip to content

Add documentation for getBulkPlaylists to accept permalinks, remove getPlaylistByHandleAndSlug from docs#678

Merged
rickyrombo merged 2 commits intomainfrom
mjp-playlists-by-permalink-docs
Mar 2, 2026
Merged

Add documentation for getBulkPlaylists to accept permalinks, remove getPlaylistByHandleAndSlug from docs#678
rickyrombo merged 2 commits intomainfrom
mjp-playlists-by-permalink-docs

Conversation

@rickyrombo
Copy link
Contributor

breaking change for sdk generation, but I think we should def move away from these "by_permalink"/"by-permalink" variants and just use the root v1/playlists endpoint w/ permalink query parameters. I actively want to remove the existing "ByHandleAndSlug" because it confused the AI

Copy link
Member

@raymondjacobson raymondjacobson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

doesn't our client use by_permalink w/ handle + slug though?

@rickyrombo
Copy link
Contributor Author

doesn't our client use by_permalink w/ handle + slug though?

@raymondjacobson yeah i think so, and maybe embed player does to. I'll be sure to update them when doing the client side change!

@rickyrombo rickyrombo merged commit 04a262c into main Mar 2, 2026
5 checks passed
@rickyrombo rickyrombo deleted the mjp-playlists-by-permalink-docs branch March 2, 2026 21:01
rickyrombo added a commit to AudiusProject/apps that referenced this pull request Mar 2, 2026
Regenerates the SDK following
AudiusProject/api#678 and
AudiusProject/api#677
- Removes `getPlaylistByHandleAndSlug` in favor of calling
`getBulkPlaylists` with permalink arg
- Updates return values of CommentsAPI to match other writes
- Updates embed player and client to use `getBulkPlaylists`
- Updates API and SDK docs

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants